<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*-<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright 2015, 2016 Diamond Light Source Ltd.<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * All rights reserved. This program and the accompanying materials<a name="line.4"></a>
<span class="sourceLineNo">005</span> * are made available under the terms of the Eclipse Public License v1.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * which accompanies this distribution, and is available at<a name="line.6"></a>
<span class="sourceLineNo">007</span> * http://www.eclipse.org/legal/epl-v10.html<a name="line.7"></a>
<span class="sourceLineNo">008</span> */<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>package org.eclipse.january.dataset;<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>import org.eclipse.january.DatasetException;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import org.eclipse.january.IMonitor;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import org.eclipse.january.io.ILazySaver;<a name="line.14"></a>
<span class="sourceLineNo">015</span><a name="line.15"></a>
<span class="sourceLineNo">016</span>/**<a name="line.16"></a>
<span class="sourceLineNo">017</span> * This sub-interface adds the ability to write to a lazy dataset slice-by-slice<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>public interface ILazyWriteableDataset extends IDynamicDataset {<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>        /**<a name="line.21"></a>
<span class="sourceLineNo">022</span>         * See {@link IDynamicDataset#UNLIMITED}<a name="line.22"></a>
<span class="sourceLineNo">023</span>         */<a name="line.23"></a>
<span class="sourceLineNo">024</span>        public static final int UNLIMITED = IDynamicDataset.UNLIMITED;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>        /**<a name="line.26"></a>
<span class="sourceLineNo">027</span>         * Get chunking<a name="line.27"></a>
<span class="sourceLineNo">028</span>         * @return chunks (can be null)<a name="line.28"></a>
<span class="sourceLineNo">029</span>         */<a name="line.29"></a>
<span class="sourceLineNo">030</span>        public int[] getChunking();<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>        /**<a name="line.32"></a>
<span class="sourceLineNo">033</span>         * Set chunking<a name="line.33"></a>
<span class="sourceLineNo">034</span>         * @param chunks chunk shape<a name="line.34"></a>
<span class="sourceLineNo">035</span>         */<a name="line.35"></a>
<span class="sourceLineNo">036</span>        public void setChunking(int... chunks);<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>        /**<a name="line.38"></a>
<span class="sourceLineNo">039</span>         * Set saver<a name="line.39"></a>
<span class="sourceLineNo">040</span>         * @param saver<a name="line.40"></a>
<span class="sourceLineNo">041</span>         */<a name="line.41"></a>
<span class="sourceLineNo">042</span>        public void setSaver(ILazySaver saver);<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>        /**<a name="line.44"></a>
<span class="sourceLineNo">045</span>         * Set a slice of the dataset<a name="line.45"></a>
<span class="sourceLineNo">046</span>         * <a name="line.46"></a>
<span class="sourceLineNo">047</span>         * @param monitor<a name="line.47"></a>
<span class="sourceLineNo">048</span>         * @param data<a name="line.48"></a>
<span class="sourceLineNo">049</span>         * @param slice an n-D slice<a name="line.49"></a>
<span class="sourceLineNo">050</span>         * @throws DatasetException<a name="line.50"></a>
<span class="sourceLineNo">051</span>         */<a name="line.51"></a>
<span class="sourceLineNo">052</span>        public void setSlice(final IMonitor monitor, final IDataset data, final SliceND slice) throws DatasetException;<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>        /**<a name="line.54"></a>
<span class="sourceLineNo">055</span>         * Set a slice of the dataset<a name="line.55"></a>
<span class="sourceLineNo">056</span>         * <a name="line.56"></a>
<span class="sourceLineNo">057</span>         * @param monitor<a name="line.57"></a>
<span class="sourceLineNo">058</span>         * @param data<a name="line.58"></a>
<span class="sourceLineNo">059</span>         * @param start<a name="line.59"></a>
<span class="sourceLineNo">060</span>         *            specifies the starting indexes (can be null for origin)<a name="line.60"></a>
<span class="sourceLineNo">061</span>         * @param stop<a name="line.61"></a>
<span class="sourceLineNo">062</span>         *            specifies the stopping indexes (can be null for end)<a name="line.62"></a>
<span class="sourceLineNo">063</span>         * @param step<a name="line.63"></a>
<span class="sourceLineNo">064</span>         *            specifies the steps in the slice (can be null for unit steps)<a name="line.64"></a>
<span class="sourceLineNo">065</span>         * @throws DatasetException<a name="line.65"></a>
<span class="sourceLineNo">066</span>         */<a name="line.66"></a>
<span class="sourceLineNo">067</span>        public void setSlice(final IMonitor monitor, final IDataset data, final int[] start, final int[] stop, final int[] step) throws DatasetException;<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span>        /**<a name="line.69"></a>
<span class="sourceLineNo">070</span>         * Set a slice of the dataset synchronously<a name="line.70"></a>
<span class="sourceLineNo">071</span>         * <a name="line.71"></a>
<span class="sourceLineNo">072</span>         * @param monitor<a name="line.72"></a>
<span class="sourceLineNo">073</span>         * @param data<a name="line.73"></a>
<span class="sourceLineNo">074</span>         * @param slice an n-D slice<a name="line.74"></a>
<span class="sourceLineNo">075</span>         * @throws DatasetException<a name="line.75"></a>
<span class="sourceLineNo">076</span>         */<a name="line.76"></a>
<span class="sourceLineNo">077</span>        public void setSliceSync(final IMonitor monitor, final IDataset data, final SliceND slice) throws DatasetException;<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span>        /**<a name="line.79"></a>
<span class="sourceLineNo">080</span>         * Set writing slices as asynchronous<a name="line.80"></a>
<span class="sourceLineNo">081</span>         * @param async<a name="line.81"></a>
<span class="sourceLineNo">082</span>         */<a name="line.82"></a>
<span class="sourceLineNo">083</span>        public void setWritingAsync(boolean async);<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span>        /**<a name="line.85"></a>
<span class="sourceLineNo">086</span>         * Get the value used to fill an un-initialized dataset<a name="line.86"></a>
<span class="sourceLineNo">087</span>         * @return fill value<a name="line.87"></a>
<span class="sourceLineNo">088</span>         */<a name="line.88"></a>
<span class="sourceLineNo">089</span>        public Object getFillValue();<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span>        /**<a name="line.91"></a>
<span class="sourceLineNo">092</span>         * Set the value used to fill an un-initialized dataset<a name="line.92"></a>
<span class="sourceLineNo">093</span>         * @param fill<a name="line.93"></a>
<span class="sourceLineNo">094</span>         */<a name="line.94"></a>
<span class="sourceLineNo">095</span>        public void setFillValue(Object fill);<a name="line.95"></a>
<span class="sourceLineNo">096</span>}<a name="line.96"></a>




























































</pre>
</div>
</body>
</html>
